/* Copyright Statement:
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein is
 * confidential and proprietary to MediaTek Inc. and/or its licensors. Without
 * the prior written permission of MediaTek inc. and/or its licensors, any
 * reproduction, modification, use or disclosure of MediaTek Software, and
 * information contained herein, in whole or in part, shall be strictly
 * prohibited.
 *
 * MediaTek Inc. (C) 2015. All rights reserved.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
 * RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
 * ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH THE MEDIATEK SOFTWARE, AND RECEIVER AGREES
 * TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK
 * SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE
 * RELEASED HEREUNDER WILL BE, AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE
 * MEDIATEK SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
 * CHARGE PAID BY RECEIVER TO MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 *
 * The following software/firmware and/or related documentation ("MediaTek
 * Software") have been modified by MediaTek Inc. All revisions are subject to
 * any receiver's applicable license agreements with MediaTek Inc.
 */
package com.mediatek.camera.v2.vendortag;

import android.hardware.camera2.CameraCharacteristics.Key;

/**
 * This class defines mtk added key/value map used for querying for camera characteristics or
 * capture results, and for setting camera request parameters.
 */
public class TagMetadata {

    /**
     * <p>
     * Do not include gesture detection statistics in capture results.
     * </p>
     *
     * @see TagRequest#STATISTICS_GESTURE_MODE
     */
    public static final int MTK_FACE_FEATURE_GESTURE_MODE_OFF = 0;

    /**
     * <p>
     * Return there is gesture in preview frame or not.
     * </p>
     *
     * @see TagRequest#STATISTICS_GESTURE_MODE
     */
    public static final int MTK_FACE_FEATURE_GESTURE_MODE_SIMPLE = 1;

    /**
     * <p>
     * Do not include smile detection statistics in capture results.
     * </p>
     *
     * @see TagRequest#STATISTICS_SMILE_MODE
     */
    public static final int MTK_FACE_FEATURE_SMILE_MODE_OFF = 0;

    /**
     * <p>
     * Return there is face smile in preview frame or not.
     * </p>
     *
     * @see TagRequest#STATISTICS_SMILE_MODE
     */
    public static final int MTK_FACE_FEATURE_SMILE_MODE_SIMPLE = 1;

    /**
     * <p>
     * Do not include auto scene detection statistics in capture results.
     * </p>
     *
     * @see TagRequest#STATISTICS_ASD_MODE
     */
    public static final int MTK_FACE_FEATURE_ASD_MODE_OFF = 0;

    /**
     * <p>
     * Return scene value.
     * </p>
     *
     * @see TagRequest#STATISTICS_ASD_MODE
     */
    public static final int MTK_FACE_FEATURE_ASD_MODE_SIMPLE = 1;
    /**
     * <p>
     * Return scene and HDR values.
     * </p>
     *
     * @see TagRequest#STATISTICS_ASD_MODE
     */
    public static final int MTK_FACE_FEATURE_ASD_MODE_FULL = 2;

    /**
     * <p>
     * Do not include 3DNR statistics in capture results.
     * </p>
     *
     * @see TagRequest#STATISTICS_3DNR_MODE
     */
    public static final int MTK_3DNR_MODE_OFF = 0;
    /**
     * <p>
     * Include 3DNR statistics in capture results.
     * </p>
     *
     * @see TagRequest#STATISTICS_3DNR_MODE
     */
    public static final int MTK_3DNR_MODE_ON = 1;
    /**
     * <p>
     * List of gesture modes for {@link TagRequest#STATISTICS_GESTURE_MODE
     * com.mediatek.facefeature.gesturemode} that are supported by this camera device.
     * </p>
     * <p>
     * This list contains the modes that can be set for the camera device.
     * </p>
     * <p>
     * If no gesture modes are supported by the camera device, this will be set to DISABLED.
     * Otherwise DISABLED will not be listed.
     * </p>
     * <p>
     * <b>Range of valid values:</b><br>
     * Any value listed in {@link TagRequest#STATISTICS_GESTURE_MODE
     * com.mediatek.facefeature.gesturemode}
     * </p>
     * <p>
     * This key is not available on all devices currently.
     * </p>
     *
     * @see TagRequest#STATISTICS_GESTURE_MODE
     */
    public static final Key<int[]> GESTURE_AVAILABLE_MODES = new Key<int[]>(
            "com.mediatek.facefeature.availablegesturemodes", int[].class);
    /**
     * <p>
     * List of smile modes for {@link TagRequest#STATISTICS_SMILE_MODE
     * com.mediatek.facefeature.smiledetectmode} that are supported by this camera device.
     * </p>
     * <p>
     * This list contains the modes that can be set for the camera device.
     * </p>
     * <p>
     * If no smile modes are supported by the camera device, this will be set to DISABLED. Otherwise
     * DISABLED will not be listed.
     * </p>
     * <p>
     * <b>Range of valid values:</b><br>
     * Any value listed in {@link TagRequest#STATISTICS_SMILE_MODE
     * com.mediatek.facefeature.smiledetectmode}
     * </p>
     * <p>
     * This key is not available on all devices currently.
     * </p>
     *
     * @see TagRequest#STATISTICS_SMILE_MODE
     */
    public static final Key<int[]> SMILE_AVAILABLE_MODES = new Key<int[]>(
            "com.mediatek.facefeature.availablesmiledetectmodes", int[].class);
    /**
     * <p>
     * List of auto scene modes for {@link TagRequest#STATISTICS_ASD_MODE
     * com.mediatek.facefeature.asdmode} that are supported by this camera device.
     * </p>
     * <p>
     * This list contains the modes that can be set for the camera device.
     * </p>
     * <p>
     * If no auto scene modes are supported by the camera device, this will be set to DISABLED.
     * Otherwise DISABLED will not be listed.
     * </p>
     * <p>
     * <b>Range of valid values:</b><br>
     * Any value listed in {@link TagRequest#STATISTICS_ASD_MODE com.mediatek.facefeature.asdmode}
     * </p>
     * <p>
     * This key is not available on all devices currently.
     * </p>
     *
     * @see TagRequest#STATISTICS_ASD_MODE
     */
    public static final Key<int[]> ASD_AVAILABLE_MODES = new Key<int[]>(
            "com.mediatek.facefeature.availableasdmodes", int[].class);
    /**
     * <p>
     * List of 3DNR modes for {@link TagRequest#STATISTICS_3DNR_MODE
     * com.mediatek.nrfeature.3dnrmode} that are supported by this camera device.
     * </p>
     * <p>
     * This list contains the modes that can be set for the camera device.
     * </p>
     * <p>
     * If no 3DNR modes are supported by the camera device, this will be set to DISABLED. Otherwise
     * DISABLED will not be listed.
     * </p>
     * <p>
     * <b>Range of valid values:</b><br>
     * Any value listed in {@link TagRequest#STATISTICS_3DNR_MODE com.mediatek.nrfeature.3dnrmode}
     * </p>
     * <p>
     * This key is not available on all devices currently.
     * </p>
     *
     * @see TagRequest#STATISTICS_3DNR_MODE
     */
    public static final Key<int[]> NR3D_AVAILABLE_MODES = new Key<int[]>(
            "com.mediatek.nrfeature.available3dnrmodes", int[].class);

}
